Deduplicate the `discover` step documentation #3311

mcasquer · 2024-10-23T10:38:33Z

Currently, the documentation about discover is duplicated in someway between the specification and the plugin section. Adds the missing information into the plugin section as it will be the primary source.

Pull Request Checklist

write the documentation
update the specification
adjust plugin docstring
include a release note

mcasquer · 2024-10-23T10:41:18Z

@psss I am not sure about deleting also the follwoing lines

tmt/tmt/steps/discover/fmf.py

Lines 229 to 237 in 1de4920

    
               It is also possible to limit tests only to those that have changed 
        
               in git since a given revision. This can be particularly useful when 
        
               testing changes to tests themselves (e.g. in a pull request CI). 
        
               Related config options (all optional): 
        
               * ``modified-only`` - set to ``true`` if you want to filter modified tests 
        
               * ``modified-url`` - fetched as "reference" remote in the test dir 
        
               * ``modified-ref`` - the ref to compare against

The configs are explained in the inherited configuration

mcasquer · 2024-10-23T10:42:03Z

Also @psss should I include the removal of the no longer needed information from the specs in this PR?

therazix

Looks good, just a couple formatting suggestions.

tmt/steps/discover/fmf.py

mcasquer · 2025-02-05T09:36:59Z

Hello, how can I fix the CI pathspec issue?
error: pathspec '1.42.0' did not match any file(s) known to git

happz · 2025-02-05T10:01:27Z

Hello, how can I fix the CI pathspec issue? error: pathspec '1.42.0' did not match any file(s) known to git

Hopefully soon to be fixed by #3507

tmt/steps/discover/fmf.py

tmt/steps/discover/shell.py

mcasquer · 2025-02-12T13:43:33Z

For some reason with the current patch the following command is not working:

(dev) [mcasquer@fedora tmt]$ tmt run discover --how fmf --help
Unhandled ReST node '<emphasis>default</emphasis>'.

It's likely related with the deletion in the discover.fmf but after restoring the file I don't see it works...

happz · 2025-02-12T13:53:31Z

For some reason with the current patch the following command is not working:
(dev) [mcasquer@fedora tmt]$ tmt run discover --how fmf --help
Unhandled ReST node '<emphasis>default</emphasis>'.
It's likely related with the deletion in the discover.fmf but after restoring the file I don't see it works...

Removed file is not causing this, it's about what was added to discover/fmf plugin:

            Additionally, one can set ``ref`` dynamically.
            This is possible using a special file in tmt format
            stored in the *default* branch of a tests repository.
            This special file should contain rules assigning attribute ``ref``
            in an `adjust` block, for example depending on a test run context.

The *default* is the emphasis tmt does not know how to render for CLI.

If you add the following bit to your code, does it work?

diff --git a/tmt/utils/rest.py b/tmt/utils/rest.py
index c7f4a613..2ee4431c 100644
--- a/tmt/utils/rest.py
+++ b/tmt/utils/rest.py
@@ -201,6 +201,13 @@ class RestVisitor(docutils.nodes.NodeVisitor):
 
     depart_literal = _noop_departure
 
+    def visit_emphasis(self, node: docutils.nodes.literal) -> None:
+        self.log_visit(str(node))
+
+        self._emit(click.style(node.astext(), fg='yellow'))
+
+    depart_emphasis = _noop_departure
+
     def visit_literal_block(self, node: docutils.nodes.literal_block) -> None:
         self.log_visit(str(node))

mcasquer · 2025-02-12T15:27:00Z

The *default* is the emphasis tmt does not know how to render for CLI.

If you add the following bit to your code, does it work?

@happz thanks for the quick reply, that makes sense.
Yeah it works ! I only need to change `adjust` to *adjust* 😀

mcasquer · 2025-02-14T08:08:24Z

@psss any more thoughts on this PR?

therazix

Just a couple of suggestions.

tmt/steps/discover/fmf.py

tmt/steps/discover/shell.py

tmt/steps/discover/fmf.py

spec/plans/discover.fmf

Currently, the documentation about discover is duplicated in someway between the specification and the plugin section. Adds the missing information into the plugin section as it will be the primary source. Signed-off-by: mcasquer <[email protected]>

Updates the modified tests behavior configs putting more information and adds all the parameters supported. Signed-off-by: mcasquer <[email protected]>

Signed-off-by: mcasquer <[email protected]>

Also adds some missing information for dis git configs. Signed-off-by: mcasquer <[email protected]>

Also updates the adjust litearal to be compatible with this function. Signed-off-by: mcasquer <[email protected]>

Signed-off-by: mcasquer <[email protected]>

mcasquer force-pushed the discover_deduplication branch from 1de4920 to f467ba5 Compare October 23, 2024 10:41

mcasquer marked this pull request as ready for review November 11, 2024 08:51

mcasquer requested review from psss, lukaszachy, happz, thrix and janhavlin as code owners November 11, 2024 08:51

mcasquer force-pushed the discover_deduplication branch from f467ba5 to 137f23f Compare January 20, 2025 13:23

mcasquer requested a review from martinhoyer as a code owner January 20, 2025 13:23

mcasquer force-pushed the discover_deduplication branch 6 times, most recently from 6fcb18e to 443cc56 Compare January 27, 2025 14:03

happz added this to the 1.43 milestone Jan 30, 2025

happz added the documentation Improvements or additions to documentation label Jan 30, 2025

KwisatzHaderach approved these changes Jan 30, 2025

View reviewed changes

therazix approved these changes Feb 4, 2025

View reviewed changes

therazix reviewed Feb 4, 2025

View reviewed changes

tmt/steps/discover/fmf.py Outdated Show resolved Hide resolved

tmt/steps/discover/fmf.py Outdated Show resolved Hide resolved

mcasquer force-pushed the discover_deduplication branch from 1dd0e5a to c71fac2 Compare February 4, 2025 22:38